home *** CD-ROM | disk | FTP | other *** search
/ Network Support Library / RoseWare - Network Support Library.iso / apidev / tpapi.exe / DOCS / OLDDOCS.LZH / NWSYNCH.DOC < prev    next >
Text File  |  1992-10-26  |  12KB  |  306 lines
  1.                            SYNCHRONIZATION SERVICES
  2.                            ========================
  3.  
  4. --------------------------------------------------------------------------------
  5.  
  6.   ClearFile (FileName : PathNameType) : WORD;
  7.  
  8.     Unlocks the specified file and removes it from the log table of the
  9.     requesting workstation.
  10.  
  11.     FileName (Input)                  : filename and optional full path of the
  12.                                         file to clear.
  13.  
  14. --------------------------------------------------------------------------------
  15.  
  16.   ClearFileSet
  17.  
  18.     Unlocks and removes all files in the log table of the requesting
  19.     workstation.
  20.  
  21. --------------------------------------------------------------------------------
  22.  
  23.   ClearLogicalRecord (LogicalRecordName : LogicalRecordNameType) : WORD;
  24.  
  25.     Unlocks a logical records and removes them from the log table of the
  26.     requesting workstation.
  27.  
  28.     LogicalRecordName (Input)         : string containing the logical record
  29.                                         name.
  30.  
  31. --------------------------------------------------------------------------------
  32.  
  33.   ClearLogicalRecordSet
  34.  
  35.     Unlocks all logical records in the log table of the requesting workstation
  36.     and removes them from the log table.
  37.  
  38. --------------------------------------------------------------------------------
  39.  
  40.   ClearPhysicalRecord (FileHandle : WORD; RecordOffset,
  41.                        RecordLength : LONGINT) : WORD;
  42.  
  43.     Unlocks a Physical record and removes them from the log table of the
  44.     requesting workstation.
  45.  
  46.     FileHandle (Input)                : DOS file handle of the file containing
  47.                                         the record to be cleared.
  48.  
  49.     RecordOffset (Input)              : offset within the file where the record
  50.                                         begins.
  51.  
  52.     RecordLength (Input)              : length of the record to clear.
  53.  
  54. --------------------------------------------------------------------------------
  55.  
  56.   ClearPhysicalRecordSet
  57.  
  58.     Unlocks all physical records in the log table of the requesting workstation
  59.     and removes them from the log table.
  60.  
  61. --------------------------------------------------------------------------------
  62.  
  63.   CloseSemaphore (SemaphoreHandle : LONGINT) : WORD;
  64.  
  65.     Closes a semaphore.
  66.  
  67.     SemaphoreHandle (Input)           : semaphore handle of an open semaphore.
  68.  
  69. --------------------------------------------------------------------------------
  70.  
  71.   ExamineSemaphore (SemaphoreHandle : LONGINT; VAR SemaphoreValue : WORD;
  72.                     VAR OpenCount : WORD) : WORD;
  73.  
  74.     Returns the current value and open count for a semaphore.
  75.  
  76.     SemaphoreHandle (Input)           : semaphore handle of the semaphore to
  77.                                         examine.
  78.  
  79.     SemaphoreValue (Output)           : value of the semaphore.
  80.  
  81.     OpenCount (Output)                : number of processes that have the
  82.                                         semaphore open.
  83.  
  84. --------------------------------------------------------------------------------
  85.  
  86.   GetLockMode : WORD;
  87.  
  88.     Returns the current lock mode.
  89.  
  90. --------------------------------------------------------------------------------
  91.  
  92.   LockFileSet (TimeOut : WORD) : WORD;
  93.  
  94.     Attempts to lock all files in the log table of the requesting workstation.
  95.  
  96.     TimeOut (Input)                   : timeout value.
  97.  
  98. --------------------------------------------------------------------------------
  99.  
  100.   LockLogicalRecordSet (LockDirective : BYTE; TimeOut : WORD) : WORD;
  101.  
  102.     Attempts to lock all logical records in the log table of the requesting
  103.     workstation.
  104.     NOTE : LOCK MODE MUST BE SET TO 1 FOR THIS CALL TO FUNCTION CORRECTLY.
  105.  
  106.     LockDirective (Input)             : indicates if and how the record should
  107.                                         be locked.
  108.  
  109.                                         0 = log record.
  110.                                         1 = log and lock record with an
  111.                                             exclusive lock.
  112.                                         3 = log and lock record with a
  113.                                             shareable readonly lock.
  114.  
  115.     TimeOut (Input)                   : timeout value.
  116.  
  117. --------------------------------------------------------------------------------
  118.  
  119.   LockPhysicalRecordSet (LockDirective : BYTE; TimeOut : WORD) : WORD;
  120.  
  121.     Attempts to lock all Physical records in the log table of the requesting
  122.     workstation.
  123.  
  124.     LockDirective (Input)             : indicates if and how the record should
  125.                                         be locked.
  126.  
  127.                                         0 = lock records with exclusive locks.
  128.                                         1 = lock records with shareable readonly
  129.                                             locks.
  130.  
  131.     TimeOut (Input)                   : timeout value.
  132.  
  133. --------------------------------------------------------------------------------
  134.  
  135.   LogFile (FileName : PathNameType; LockDirective : BYTE;
  136.            TimeOut : WORD) : WORD;
  137.  
  138.     Logs a file into the log table of the requesting workstation and,
  139.     optionally, locks the file.
  140.  
  141.     FileName (Input)                  : filename and optional full path.
  142.  
  143.     LockDirective (Input)             : indicates how the file should be locked.
  144.  
  145.                                         0 = log file.
  146.                                         1 = log and lock file.
  147.                                         2 = log and lock shareable.
  148.  
  149.     TimeOut (Input)                   : timeout value. (only valid if
  150.                                                         LOCKMODE = 1)
  151.  
  152. --------------------------------------------------------------------------------
  153.  
  154.   LogLogicalRecord (LogicalRecordName : LogicalRecordNameType;
  155.                     LockDirective : BYTE; TimeOut : WORD) : WORD;
  156.  
  157.     Logs a logical record string into the log table of the requesting
  158.     workstation and, optionally, locks the record.
  159.  
  160.     LogicalRecordName (Input)         : string containing the record name.
  161.  
  162.     LockDirective (Input)             : indicates if and how the record should
  163.                                         be locked.
  164.  
  165.                                         0 = log record.
  166.                                         1 = log and lock record with an
  167.                                             exclusive lock.
  168.                                         3 = log and lock record with a
  169.                                             shareable readonly lock.
  170.  
  171.     TimeOut (Input)                   : timeout value. (only valid if LOCKMODE
  172.                                                         not equal to 0)
  173.  
  174. --------------------------------------------------------------------------------
  175.  
  176.   LogPhysicalRecord (FileHandle : WORD; RecordOffset, RecordLength : LONGINT;
  177.                      LockDirective : BYTE; TimeOut : WORD) : WORD;
  178.  
  179.     Logs a physical record into the log table of the requesting workstation
  180.     and, optionally, locks the record.
  181.  
  182.     FileHandle (Input)                : DOS file handle of the file containing
  183.                                         the record to be logged.
  184.  
  185.     RecordOffset (Input)              : offset within the file where the record
  186.                                         begins.
  187.  
  188.     RecordLength (Input)              : length of the record.
  189.  
  190.     LockDirective (Input)             : indicates if and how the record should
  191.                                         be locked.
  192.  
  193.                                         0 = lock records with exclusive locks.
  194.                                         1 = lock records with shareable readonly
  195.                                             locks.
  196.  
  197.     TimeOut (Input)                   : timeout value. (only valid if LOCKMODE
  198.                                                         not equal to 0)
  199.  
  200. --------------------------------------------------------------------------------
  201.  
  202.   OpenSemaphore (SemaphoreName : SemaphoreNameType; InitialValue : WORD;
  203.                  VAR SemaphoreHandle : LONGINT; VAR OpenCount : WORD) : WORD;
  204.  
  205.     Opens the specified semaphore or creates it if it does not exist.
  206.  
  207.     SemaphoreName (Input)             : name of the semaphore to open.
  208.  
  209.     InitialValue (Input)              : inital value of the semaphore. Only
  210.                                         applies if semaphore does not yet
  211.                                         exist.
  212.  
  213.     SemaphoreName (Output)            : returns the semaphore handle.
  214.  
  215.     OpenCount (Output)                : receives the number of processes that
  216.                                         have the semaphore open.
  217.  
  218. --------------------------------------------------------------------------------
  219.  
  220.   ReleaseFile (FileName : PathNameType) : WORD;
  221.  
  222.     Unlocks the specified file in the log table of the requesting workstation
  223.     but does not delete the file.
  224.  
  225.     FileName (Input)                  : filename containing optional full path.
  226.  
  227. --------------------------------------------------------------------------------
  228.  
  229.   ReleaseFileSet
  230.  
  231.     Unlocks all files currently locked in the log table of the requesting
  232.     workstation but does not delete them from the table.
  233.  
  234. --------------------------------------------------------------------------------
  235.  
  236.   ReleaseLogicalRecord (LogicalRecordName : LogicalRecordNameType) : WORD;
  237.  
  238.     Unlocks a logical record in the log table of the requesting workstation but
  239.     does not remove the record from the table.
  240.  
  241.     LogicalRecordName (Input)         : logical record name to release.
  242.  
  243. --------------------------------------------------------------------------------
  244.  
  245.   ReleaseLogicalRecordSet
  246.  
  247.     Unlocks all logical records currently locked in the log table of the
  248.     requesting workstation but does not remove them from the log table.
  249.  
  250. --------------------------------------------------------------------------------
  251.  
  252.   ReleasePhysicalRecord (FileHandle : WORD; RecordOffset,
  253.                          RecordLength : LONGINT) : WORD;
  254.  
  255.     Unlocks a physical record in the log table of the requesting workstation but
  256.     does not remove the record from the table.
  257.  
  258.     FileHandle (Input)                : DOS file handle of the file containing
  259.                                         the record to be logged.
  260.  
  261.     RecordOffset (Input)              : offset within the file where the record
  262.                                         begins.
  263.  
  264.     RecordLength (Input)              : length of the record.
  265.  
  266. --------------------------------------------------------------------------------
  267.  
  268.   ReleasePhysicallRecordSet
  269.  
  270.     Unlocks all physical records currently locked in the log table of the
  271.     requesting workstation but does not remove them from the log table.
  272.  
  273. --------------------------------------------------------------------------------
  274.  
  275.   SetLockMode (LockMode : BYTE) : WORD;
  276.  
  277.     Sets the lock mode.
  278.  
  279.     LockMode (Input)                  : indicates how Netware handles the
  280.                                         locking functions.
  281.  
  282.                                         0 = compatibility lock mode.
  283.                                             (Netware v4.6 and earlier)
  284.                                         1 = extended lock mode.
  285.                                             (Netware v2.x and later)
  286.  
  287. --------------------------------------------------------------------------------
  288.  
  289.   SignalSemaphore (SemaphoreHandle : LONGINT) : WORD;
  290.  
  291.     Increments the value of a semaphore.
  292.  
  293.     SemaphoreHandle (Input)           : semaphore handle of an open semaphore.
  294.  
  295. --------------------------------------------------------------------------------
  296.  
  297.   WaitOnSemaphore (SemaphoreHandle : LONGINT; TimeOut : WORD) : WORD;
  298.  
  299.     Decrements the value of a semaphore.
  300.  
  301.     SemaphoreHandle (Input)           : semaphore handle of the semaphore to
  302.                                         decrement.
  303.  
  304.     Timeout (Input)                   : timeout value.
  305. ------------------------------------------------------------------------------
  306.